<!DOCTYPE html>
<html lang="en-us">
  
  <head>
  <meta charset="UTF-8">
  <title>tbox</title>
  <meta name="viewport" content="width=device-width, initial-scale=1">
  <meta name="theme-color" content="#157878">
  <meta name="description" content="一个用c语言实现的跨平台开发库">
  <meta name="keywords" content="网络开发,开发库,异步io,协程,xml,json,plist,容器,迭代器,算法,流,跨平台,linux,c语言,嵌入式,ios,android" /> 

  <link rel="stylesheet" href="/assets/css/normalize.css">
  <link rel='stylesheet' href="/assets/css/opensans.css" type='text/css'>
  <link rel="stylesheet" href="/assets/css/cayman.css">

  <!-- baidu stats -->
  <!--
    <script>
    var _hmt = _hmt || [];
    (function() {
      var hm = document.createElement("script");
      hm.src = "//hm.baidu.com/hm.js?eb3c91c672a001d78a113bfb8e42017a";
      var s = document.getElementsByTagName("script")[0]; 
      s.parentNode.insertBefore(hm, s);
    })();
    </script>
    -->
</head>


  <body>
    <section class="page-header">
  <h1 class="project-name">tbox</h1>
  <h2 class="project-tagline">一个用c语言实现的跨平台开发库</h2>
  <a href="/#/zh/" class="btn">开始使用</a>
  <br><br>
  <iframe src="https://ghbtns.com/github-btn.html?user=tboox&repo=xmake&type=star&count=true" frameborder="0" scrolling="0" width="110px" height="20px"></iframe>
    <span class="donate" style="width: 86px">
      <img src="/assets/img/patreon.png">
      <a href="/cn/pages/donation.html#donate">支持我们</a>
    </span>
  <br><br>
<ul id="translations">
      <li><a href="/cn/" class="nav-link">中文</a></li>
      <li class="delimiter">|</li>
      <li><a href="/" class="nav-link">English</a></li>
    </ul>
</section>



    <section class="main-content">
      
      <h1 id="c">一个用c语言实现的跨平台开发库</h1>

<h2 id="section">简介</h2>

<p>TBOX是一个用c语言实现的跨平台开发库。</p>

<p>针对各个平台，封装了统一的接口，简化了各类开发过程中常用操作，使你在开发过程中，更加关注实际应用的开发，而不是把时间浪费在琐碎的接口兼容性上面，并且充分利用了各个平台独有的一些特性进行优化。</p>

<p>这个项目的目的，是为了使C开发更加的简单高效。</p>

<p>目前支持的平台有：</p>

<ul>
  <li>Windows</li>
  <li>Macosx</li>
  <li>Linux</li>
  <li>Android</li>
  <li>iOS</li>
</ul>

<p>通过<a href="http://www.xmake.io/cn">xmake</a>支持各种编译模式：</p>

<ul>
  <li>Release: 正式版编译，禁用调试信息、断言，各种检测机制，启用编译器优化</li>
  <li>Debug: 调试模式，默认启用详细调试信息、断言、内存越界检测、内存泄漏、锁竞争分析等检测机制</li>
  <li>Small: 默认禁用所有扩展模块，启用编译器最小化优化</li>
  <li>Micro: 针对嵌入式平台，仅仅编译tbox微内核，仅提供最基础的跨平台接口，生成库仅64K左右（内置轻量libc接口实现）</li>
</ul>

<p>如果你想了解更多，请参考：</p>

<ul>
  <li><a href="https://github.com/waruqi/tbox/wiki/%E7%9B%AE%E5%BD%95">在线文档</a></li>
  <li><a href="https://github.com/waruqi/tbox">在线源码</a></li>
  <li><a href="http://www.tboox.org/cn">项目主页</a></li>
</ul>

<h2 id="section-1">特性</h2>

<h4 id="section-2">流库</h4>

<p>针对http、file、socket、data等流数据，实现统一接口进行读写，并且支持: 阻塞、非阻塞、异步 三种读写模式。
支持中间增加多层filter流进行流过滤，实现边读取，内部边进行解压、编码转换、加密等操作，极大的减少了内存使用。</p>

<p>主要提供以下模块：</p>

<ul>
  <li><code class="highlighter-rouge">stream</code>：通用非阻塞流，用于一般的单独io处理，同时支持协程以实现异步传输。</li>
  <li><code class="highlighter-rouge">transfer</code>：流传输器，维护两路流的传输。</li>
  <li><code class="highlighter-rouge">static_stream</code>：针对静态数据buffer优化的静态流，用于轻量快速的数据解析。</li>
</ul>

<h4 id="section-3">协程库</h4>

<ul>
  <li>快速高效的协程切换支持（具体性能参考：<a href="http://tboox.org/cn/2016/10/28/benchbox-coroutine/">基准测试报告</a>）</li>
  <li>提供跨平台支持，核心切换算法参考boost，并且对其进行重写和优化，目前支持架构：x86, x86_64, arm, arm64, mips32</li>
  <li>提供channel协程间数据通信支持，基于生产、消费者模型</li>
  <li>提供信号量、协程锁支持</li>
  <li>socket、stream都模块原生支持协程，并且可在线程和协程间进行无缝切换</li>
  <li>提供http、file等基于协程的简单服务器实例，只需几百行代码，就可以从socket开始写个高性能io服务器，代码逻辑比异步回调模式更加清晰</li>
  <li>同时提供stackfull, stackless两种协程模式支持，stackless协程更加的轻量（每个协程只占用几十个bytes），切换更快（会牺牲部分易用性）</li>
</ul>

<h4 id="section-4">数据库</h4>

<ul>
  <li>统一并简化数据库操作接口，适配各种数据源，通过统一的url来自动连接打开支持的数据库，数据的枚举采用迭代器模型。</li>
  <li>目前支持sqlite3以及mysql两种关系型数据库，也可自定义扩展使用其他关系型数据库。</li>
</ul>

<h4 id="xml">xml库</h4>

<ul>
  <li>针对xml提供DOM和SAX两种解析模式，SAX方式采用外部迭代模式，灵活性和性能更高，并且可以选择指定路径，进行解析。</li>
  <li>解析过程完全基于stream，所以是高度流化的，可以实现边下载、边解压、边转码、边解析一条龙服务，使用较低的内存也可以解析大规模数据。</li>
  <li>提供xml writer以支持对xml生成</li>
</ul>

<h4 id="section-5">内存库</h4>

<ul>
  <li>参考linux内核内存管理机制的实现，并对其进行各种改造和优化，所实现的TBOX独有的一整套内存池管理架构。</li>
  <li>调试模式下，可以轻松检测并定位内存泄露、内存越界溢出、内存重叠覆盖等常见内存问题，并对整体内存的使用进行了统计和简要分析。</li>
  <li>针对大块数据、小块数据、字符串数据进行了充分的利用，避免了大量外部碎片和内部碎片的产生。分配操作进行了各种优化，96%的情况下，效率都是在O(1)。</li>
</ul>

<h4 id="section-6">容器库</h4>

<ul>
  <li>提供哈希、链表、数组、队列、堆栈、最小最大堆等常用容器。</li>
  <li>支持各种常用成员类型，在原有的容器期初上，其成员类型还可以完全自定义扩展。</li>
  <li>所有容器都支持迭代器操作。</li>
  <li>大部分容器都可以支持基于stream的序列化和反序列化操作。</li>
</ul>

<h4 id="section-7">算法库</h4>

<ul>
  <li>提供各种排序算法：冒泡排序、堆排序、快速排序、插入排序。</li>
  <li>提供各种查找算法：线性遍历、二分法搜索。</li>
  <li>提供各种遍历、删除、统计算法。</li>
  <li>以迭代器为接口，实现算法和容器的分离，类似stl，但是c实现的，更加轻量。</li>
</ul>

<h4 id="section-8">网络库</h4>

<ul>
  <li>实现http客户端模块</li>
  <li>实现cookies</li>
  <li>实现dns解析与缓存</li>
  <li>实现ssl(支持openssl, polarssl, mbedtls)</li>
  <li>支持ipv4、ipv6</li>
  <li>支持通过协程实现异步模式</li>
</ul>

<h4 id="section-9">数学运算库</h4>

<ul>
  <li>提供各种精度的定点运算支持</li>
  <li>提供随机数生成器</li>
</ul>

<h4 id="libc">libc库</h4>

<ul>
  <li>libc的一个轻量级实现，完全跨平台，并且针对不同架构进行了优化。</li>
  <li>支持大部分字符串、宽字符串操作。</li>
  <li>扩展字符串、宽字符串的各种大小写不敏感操作接口</li>
  <li>扩展<code class="highlighter-rouge">memset_u16</code>、<code class="highlighter-rouge">memset_u32</code>等接口，并对其进行高度优化，尤其适合图形渲染程序</li>
</ul>

<h4 id="libm">libm库</h4>

<ul>
  <li>libm部分接口的一个轻量级实现，以及对常用系统接口的封装。（目前只实现了部分，之后有时间会完全实现掉）</li>
  <li>扩展部分常用接口，增加对sqrt、log2等常用函数的整数版本计算，进行高度优化，不涉及浮点运算，适合嵌入式环境使用。</li>
</ul>

<h4 id="object">object库</h4>

<ul>
  <li>轻量级类apple的CoreFoundation库，支持object、dictionary、array、string、number、date、data等常用对象，并且可以方便扩展自定义对象的序列化。</li>
  <li>支持对xml、json、binary以及apple的plist(xplist/bplist)格式序列化和反序列化。
并且实现自有的binary序列化格式， 针对明文进行了简单的加密，在不影响性能的前提下，序列化后的大小比bplist节省30%。</li>
</ul>

<h4 id="section-10">平台库</h4>

<ul>
  <li>提供file、directory、socket、thread、time等常用系统接口</li>
  <li>提供atomic、atomic64接口</li>
  <li>提供高精度、低精度定时器</li>
  <li>提供高性能的线程池操作</li>
  <li>提供event、mutex、semaphore、spinlock等事件、互斥、信号量、自旋锁操作</li>
  <li>提供获取函数堆栈信息的接口，方便调试和错误定位</li>
  <li>提供跨平台动态库加载接口（如果系统支持的话）</li>
  <li>提供io轮询器，针对epoll, poll, select, kqueue进行跨平台封装</li>
  <li>提供跨平台上下文切换接口，主要用于协程实现，切换效率非常高</li>
</ul>

<h4 id="section-11">压缩库</h4>

<ul>
  <li>支持zlib/zlibraw/gzip的压缩与解压（需要第三方zlib库支持）。</li>
</ul>

<h4 id="section-12">字符编码库</h4>

<ul>
  <li>支持utf8、utf16、gbk、gb2312、uc2、uc4 之间的互相转码，并且支持大小端格式。</li>
</ul>

<h4 id="section-13">实用工具库</h4>

<ul>
  <li>实现base64/32编解码</li>
  <li>实现crc32、adler32、md5、sha1等常用hash算法</li>
  <li>实现日志输出、断言等辅助调试工具</li>
  <li>实现url编解码</li>
  <li>实现位操作相关接口，支持各种数据格式的解析，可以对8bits、16bits、32bits、64bits、float、double以及任意bits的字段进行解析操作，并且同时支持大端、小端和本地端模式，并针对部分操作进行了优化，像static_stream、stream都有相关接口对其进行了封装，方便在流上进行快速数据解析。</li>
  <li>实现swap16、swap32、swap64等位交换操作，并针对各个平台进行了优化。</li>
  <li>实现一些高级的位处理接口，例如：位0的快速统计、前导0和前导1的快速位计数、后导01的快速位计数</li>
  <li>实现单例模块，可以对静态对象、实例对象进行快速的单例封装，实现全局线程安全</li>
  <li>实现option模块，对命令行参数进行解析，提供快速方便的命令行选项建立和解析操作，对于写终端程序还是很有帮助的</li>
</ul>

<h4 id="section-14">正则表达式库</h4>

<ul>
  <li>支持匹配和替换操作</li>
  <li>支持全局、多行、大小写不敏感等模式</li>
  <li>使用pcre, pcre2和posix正则库</li>
</ul>

<h4 id="asio-">asio库 (已废弃)</h4>

<ul>
  <li>请使用协程来进行异步io编程</li>
</ul>

<h2 id="section-15">后续任务</h2>

<ul>
  <li>重构xml模块</li>
  <li>添加更多的容器和算法</li>
  <li>优化更多的libc接口</li>
  <li>实现更多的libm接口，而不仅仅是包裹到系统api</li>
</ul>

<h2 id="tbox">一些使用tbox的项目：</h2>

<ul>
  <li><a href="https://github.com/waruqi/gbox">gbox</a></li>
  <li><a href="https://github.com/waruqi/vm86">vm86</a></li>
  <li><a href="http://www.xmake.io/cn">xmake</a></li>
  <li><a href="https://github.com/waruqi/itrace">itrace</a></li>
  <li><a href="https://github.com/waruqi/tbox/wiki/%E4%BD%BF%E7%94%A8tbox%E7%9A%84%E5%BC%80%E6%BA%90%E5%BA%93">更多项目</a></li>
</ul>

<h2 id="section-16">编译</h2>

<p>请先安装: <a href="https://github.com/waruqi/xmake">xmake</a></p>

<div class="highlighter-rouge"><pre class="highlight"><code># 默认直接编译当前主机平台
cd ./tbox
xmake

# 编译mingw平台
cd ./tbox
xmake f -p mingw --sdk=/home/mingwsdk 
xmake

# 编译iphoneos平台
cd ./tbox
xmake f -p iphoneos 
xmake

# 编译android平台
cd ./tbox
xmake f -p android --ndk=xxxxx
xmake

# 交叉编译
cd ./tbox
xmake f -p linux --sdk=/home/sdk #--toolchains=/home/sdk/bin
xmake
</code></pre>
</div>

<h2 id="section-17">例子</h2>

<div class="highlighter-rouge"><pre class="highlight"><code>#include "tbox/tbox.h"

int main(int argc, char** argv)
{
    // init tbox
    if (!tb_init(tb_null, tb_null)) return 0;

    // trace
    tb_trace_i("hello tbox");

    // init vector
    tb_vector_ref_t vector = tb_vector_init(0, tb_element_cstr(tb_true));
    if (vector)
    {
        // insert item
        tb_vector_insert_tail(vector, "hello");
        tb_vector_insert_tail(vector, "tbox");

        // dump all items
        tb_for_all (tb_char_t const*, cstr, vector)
        {
            // trace
            tb_trace_i("%s", cstr);
        }

        // exit vector
        tb_vector_exit(vector);
    }

    // init stream
    tb_stream_ref_t stream = tb_stream_init_from_url("http://www.xxx.com/file.txt");
    if (stream)
    {
        // open stream
        if (tb_stream_open(stream))
        {
            // read line
            tb_long_t size = 0;
            tb_char_t line[TB_STREAM_BLOCK_MAXN];
            while ((size = tb_stream_bread_line(stream, line, sizeof(line))) &gt;= 0)
            {
                // trace
                tb_trace_i("line: %s", line);
            }
        }

        // exit stream
        tb_stream_exit(stream);
    }

    // wait some time
    getchar();

    // exit tbox
    tb_exit();
    return 0;
}
</code></pre>
</div>

<h4 id="section-18">联系方式</h4>

<ul>
  <li>邮箱：<a href="mailto:waruqi@gmail.com">waruqi@gmail.com</a></li>
  <li>主页：<a href="http://www.tboox.org/cn">TBOOX开源工程</a></li>
  <li>社区：<a href="http://www.tboox.org/forum">TBOOX开源社区</a></li>
  <li>QQ群：343118190</li>
  <li>微信公众号：tboox-os</li>
</ul>



      <footer class="site-footer">
  <span class="site-footer-owner">Copyright (c) 2015-2017 <a href="http://www.tboox.org">tboox.org</a>.</span>
  <span class="site-footer-power">
    <span>
        <!--Site powered by <a href="https://jekyllrb.com/">Jekyll</a> & <a href="http://pages.coding.me">Coding Pages</a>.-->
        Site powered by <a href="https://jekyllrb.com/">Jekyll</a> & <a href="https://pages.github.com/">Github Pages</a>.
    </span>
    <span>
        Theme designed by <a href="https://github.com/pietromenna/jekyll-cayman-theme">cayman</a>.
    </span>
</span>
</footer>


    </section>

  </body>
</html>
